################################################################################
#
# Macros for handling the st-link utility (See https://github.com/texane/stlink)
#
# Copyright (c) 2014, B&R Industrial Automation GmbH
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of the copyright holders nor the
#       names of its contributors may be used to endorse or promote products
#       derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
################################################################################

MACRO(FindStLink)
    FIND_PROGRAM(STLINK_FLASH_LOC NAMES st-flash
                 DOC "Location of the st-link flashing utility"
                )

    FIND_PROGRAM(STLINK_UTIL_LOC NAMES st-util
                 DOC "Location of the st-link utility"
                )
ENDMACRO(FindStLink)

MACRO(CreateProgFlash TARGET_NAME FLASH_BASE_ADDR)
    IF(STLINK_UTIL_LOC AND STLINK_FLASH_LOC)
        # Target to write the executable to the local flash
        ADD_CUSTOM_TARGET(
            download-${TARGET_NAME}
            COMMAND ${CMAKE_OBJCOPY} -O binary ${TARGET_NAME}.elf ${TARGET_NAME}.bin
            COMMAND ${STLINK_FLASH_LOC} write ${TARGET_NAME}.bin ${FLASH_BASE_ADDR}
        )

        ADD_DEPENDENCIES(download-${TARGET_NAME} ${TARGET_NAME}.elf)
    ELSE()
        MESSAGE(FATAL_ERROR "The tool st-util was not found! The 'download target was not created for '${TARGET_NAME}'")
    ENDIF()
ENDMACRO(CreateProgFlash)

# Initially call the FindStLink macro
FindStLink()
